<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="utf-8">
  <meta http-equiv="X-UA-Compatible" content="IE=edge">
  <meta name="viewport" content="width=device-width, height=device-height, initial-scale=1, user-scalable=no">
  <meta name="description" content="retrofit library API docs, for the Dart programming language.">
  <title>retrofit library - Dart API</title>

  
  <link href="https://fonts.googleapis.com/css?family=Source+Code+Pro:500,400i,400,300|Source+Sans+Pro:400,300,700" rel="stylesheet">
  <link href="https://fonts.googleapis.com/icon?family=Material+Icons" rel="stylesheet">
  <link rel="stylesheet" href="../static-assets/github.css">
  <link rel="stylesheet" href="../static-assets/styles.css">
  <link rel="icon" href="../static-assets/favicon.png">
  <!-- header placeholder -->
</head>

<body>

<div id="overlay-under-drawer"></div>

<header id="title">
  <button id="sidenav-left-toggle" type="button">&nbsp;</button>
  <ol class="breadcrumbs gt-separated dark hidden-xs">
    <li><a href="../index.html">retrofit</a></li>
    <li class="self-crumb">retrofit library</li>
  </ol>
  <div class="self-name">retrofit</div>
  <form class="search navbar-right" role="search">
    <input type="text" id="search-box" autocomplete="off" disabled class="form-control typeahead" placeholder="Loading search...">
  </form>
</header>

<main>

  <div id="dartdoc-sidebar-left" class="col-xs-6 col-sm-3 col-md-2 sidebar sidebar-offcanvas-left">
    <header id="header-search-sidebar" class="hidden-l">
      <form class="search-sidebar" role="search">
        <input type="text" id="search-sidebar" autocomplete="off" disabled class="form-control typeahead" placeholder="Loading search...">
      </form>
    </header>
    
    <ol class="breadcrumbs gt-separated dark hidden-l" id="sidebar-nav">
      <li><a href="../index.html">retrofit</a></li>
      <li class="self-crumb">retrofit library</li>
    </ol>
    
    <h5><span class="package-name">retrofit</span> <span class="package-kind">package</span></h5>
    <ol>
          <li class="section-title">Libraries</li>
          <li><a href="../dio/dio-library.html">dio</a></li>
          <li><a href="../http/http-library.html">http</a></li>
          <li><a href="../retrofit/retrofit-library.html">retrofit</a></li>
    </ol>
  </div>

  <div id="dartdoc-main-content" class="col-xs-12 col-sm-9 col-md-8 main-content">
      <div><h1><span class="kind-library">retrofit</span> library </h1></div>

    
    <section class="summary offset-anchor" id="classes">
      <h2>Classes</h2>

      <dl>
        <dt id="Body">
          <span class="name "><a href="../http/Body-class.html">Body</a></span>         
        </dt>
        <dd>
          Use this annotation on a service method param when you want to directly control the request body
of a POST/PUT request (instead of sending in as request parameters or form-style request
body). <a href="../http/Body-class.html">[...]</a>
        </dd>
        <dt id="CancelRequest">
          <span class="name "><a href="../dio/CancelRequest-class.html">CancelRequest</a></span>         
        </dt>
        <dd>
           
        </dd>
        <dt id="DELETE">
          <span class="name "><a href="../http/DELETE-class.html">DELETE</a></span>         
        </dt>
        <dd>
          Make a <code>DELETE</code> request 
        </dd>
        <dt id="DioResponseType">
          <span class="name "><a href="../dio/DioResponseType-class.html">DioResponseType</a></span>         
        </dt>
        <dd>
           
        </dd>
        <dt id="Extra">
          <span class="name "><a href="../dio/Extra-class.html">Extra</a></span>         
        </dt>
        <dd>
          Extra data that will be passed to dio's request, response, transformer and interceptors. 
        </dd>
        <dt id="Field">
          <span class="name "><a href="../http/Field-class.html">Field</a></span>         
        </dt>
        <dd>
          Named pair for a form request. <a href="../http/Field-class.html">[...]</a>
        </dd>
        <dt id="FormUrlEncoded">
          <span class="name "><a href="../http/FormUrlEncoded-class.html">FormUrlEncoded</a></span>         
        </dt>
        <dd>
          Denotes that the request body will use form URL encoding. Fields should be declared as
parameters and annotated with <a href="../http/Field-class.html">Field</a>. <a href="../http/FormUrlEncoded-class.html">[...]</a>
        </dd>
        <dt id="GET">
          <span class="name "><a href="../http/GET-class.html">GET</a></span>         
        </dt>
        <dd>
          Make a <code>GET</code> request <a href="../http/GET-class.html">[...]</a>
        </dd>
        <dt id="HEAD">
          <span class="name "><a href="../http/HEAD-class.html">HEAD</a></span>         
        </dt>
        <dd>
          Make a <code>HEAD</code> request 
        </dd>
        <dt id="Header">
          <span class="name "><a href="../http/Header-class.html">Header</a></span>         
        </dt>
        <dd>
          Replaces the header with the value of its target. <a href="../http/Header-class.html">[...]</a>
        </dd>
        <dt id="Headers">
          <span class="name "><a href="../http/Headers-class.html">Headers</a></span>         
        </dt>
        <dd>
          Adds headers specified in the <a href="../http/Headers/value.html">value</a> map. 
        </dd>
        <dt id="HttpMethod">
          <span class="name "><a href="../http/HttpMethod-class.html">HttpMethod</a></span>         
        </dt>
        <dd>
          A holder that includs all http methods which are supported by retrofit. 
        </dd>
        <dt id="HttpResponse">
          <span class="name "><a href="../dio/HttpResponse-class.html">HttpResponse</a><span class="signature">&lt;<wbr><span class="type-parameter">T</span>&gt;</span></span>         
        </dt>
        <dd>
           
        </dd>
        <dt id="Method">
          <span class="name "><a href="../http/Method-class.html">Method</a></span>         
        </dt>
        <dd>
           
        </dd>
        <dt id="MultiPart">
          <span class="name "><a href="../http/MultiPart-class.html">MultiPart</a></span>         
        </dt>
        <dd>
          Denotes that the request body is multi-part. Parts should be declared as parameters and
annotated with <a href="../http/Part-class.html">Part</a>. 
        </dd>
        <dt id="OPTIONS">
          <span class="name "><a href="../http/OPTIONS-class.html">OPTIONS</a></span>         
        </dt>
        <dd>
          Make a <code>OPTIONS</code> request 
        </dd>
        <dt id="Part">
          <span class="name "><a href="../http/Part-class.html">Part</a></span>         
        </dt>
        <dd>
          Denotes a single part of a multi-part request.
Part parameters may not be null. <a href="../http/Part-class.html">[...]</a>
        </dd>
        <dt id="PATCH">
          <span class="name "><a href="../http/PATCH-class.html">PATCH</a></span>         
        </dt>
        <dd>
          Make a <code>PATCH</code> request 
        </dd>
        <dt id="Path">
          <span class="name "><a href="../http/Path-class.html">Path</a></span>         
        </dt>
        <dd>
          Named replacement in a URL path segment. <a href="../http/Path-class.html">[...]</a>
        </dd>
        <dt id="POST">
          <span class="name "><a href="../http/POST-class.html">POST</a></span>         
        </dt>
        <dd>
          Make a <code>POST</code> request 
        </dd>
        <dt id="PUT">
          <span class="name "><a href="../http/PUT-class.html">PUT</a></span>         
        </dt>
        <dd>
          Make a <code>PUT</code> request 
        </dd>
        <dt id="Queries">
          <span class="name "><a href="../http/Queries-class.html">Queries</a></span>         
        </dt>
        <dd>
          Query parameter keys and values appended to the URL. <a href="../http/Queries-class.html">[...]</a>
        </dd>
        <dt id="Query">
          <span class="name "><a href="../http/Query-class.html">Query</a></span>         
        </dt>
        <dd>
          Query parameter appended to the URL. <a href="../http/Query-class.html">[...]</a>
        </dd>
        <dt id="ReceiveProgress">
          <span class="name "><a href="../dio/ReceiveProgress-class.html">ReceiveProgress</a></span>         
        </dt>
        <dd>
           
        </dd>
        <dt id="RestApi">
          <span class="name "><a href="../http/RestApi-class.html">RestApi</a></span>         
        </dt>
        <dd>
          Define an API. 
        </dd>
        <dt id="SendProgress">
          <span class="name "><a href="../dio/SendProgress-class.html">SendProgress</a></span>         
        </dt>
        <dd>
           
        </dd>
      </dl>
    </section>









  </div> <!-- /.main-content -->

  <div id="dartdoc-sidebar-right" class="col-xs-6 col-sm-6 col-md-2 sidebar sidebar-offcanvas-right">
    <h5>retrofit library</h5>
    <ol>
      <li class="section-title"><a href="../retrofit/retrofit-library.html#classes">Classes</a></li>
      <li><a href="../http/Body-class.html">Body</a></li>
      <li><a href="../dio/CancelRequest-class.html">CancelRequest</a></li>
      <li><a href="../http/DELETE-class.html">DELETE</a></li>
      <li><a href="../dio/DioResponseType-class.html">DioResponseType</a></li>
      <li><a href="../dio/Extra-class.html">Extra</a></li>
      <li><a href="../http/Field-class.html">Field</a></li>
      <li><a href="../http/FormUrlEncoded-class.html">FormUrlEncoded</a></li>
      <li><a href="../http/GET-class.html">GET</a></li>
      <li><a href="../http/HEAD-class.html">HEAD</a></li>
      <li><a href="../http/Header-class.html">Header</a></li>
      <li><a href="../http/Headers-class.html">Headers</a></li>
      <li><a href="../http/HttpMethod-class.html">HttpMethod</a></li>
      <li><a href="../dio/HttpResponse-class.html">HttpResponse</a></li>
      <li><a href="../http/Method-class.html">Method</a></li>
      <li><a href="../http/MultiPart-class.html">MultiPart</a></li>
      <li><a href="../http/OPTIONS-class.html">OPTIONS</a></li>
      <li><a href="../http/Part-class.html">Part</a></li>
      <li><a href="../http/PATCH-class.html">PATCH</a></li>
      <li><a href="../http/Path-class.html">Path</a></li>
      <li><a href="../http/POST-class.html">POST</a></li>
      <li><a href="../http/PUT-class.html">PUT</a></li>
      <li><a href="../http/Queries-class.html">Queries</a></li>
      <li><a href="../http/Query-class.html">Query</a></li>
      <li><a href="../dio/ReceiveProgress-class.html">ReceiveProgress</a></li>
      <li><a href="../http/RestApi-class.html">RestApi</a></li>
      <li><a href="../dio/SendProgress-class.html">SendProgress</a></li>
    
    
    
    
    
    
    
    
    </ol>
  </div><!--/sidebar-offcanvas-right-->

</main>

<footer>
  <span class="no-break">
    retrofit
      1.2.0
  </span>

  <!-- footer-text placeholder -->
</footer>

<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.2.1/jquery.min.js"></script>
<script src="../static-assets/typeahead.bundle.min.js"></script>
<script src="../static-assets/highlight.pack.js"></script>
<script src="../static-assets/URI.js"></script>
<script id="dartdoc_script_js" src="../static-assets/script.js"></script>
<!-- footer placeholder -->

</body>

</html>
